home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xvc / XSGIvcSetOutputSync.z / XSGIvcSetOutputSync
Encoding:
Text File  |  2002-10-03  |  12.0 KB  |  265 lines
  1.  
  2.  
  3.  
  4.      XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttOOOOuuuuttttppppuuuuttttSSSSyyyynnnncccc((((3333))))                     XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttOOOOuuuuttttppppuuuuttttSSSSyyyynnnncccc((((3333))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XSGIvcSetOutputSync, XSGIvcQueryOutputSync - Set and query
  10.           the sync status of a sync port
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXX11111111////eeeexxxxtttteeeennnnssssiiiioooonnnnssss////XXXXSSSSGGGGIIIIvvvvcccc....hhhh>>>>
  14.  
  15.           vvvvooooiiiidddd XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttOOOOuuuuttttppppuuuuttttSSSSyyyynnnncccc((((DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,,,,
  16.               iiiinnnntttt ssssccccrrrreeeeeeeennnn,,,,
  17.               iiiinnnntttt cccchhhhaaaannnnnnnneeeellll,,,,
  18.               iiiinnnntttt ssssyyyynnnnccccPPPPoooorrrrttttIIIInnnnddddeeeexxxx,,,,
  19.               iiiinnnntttt ssssyyyynnnnccccTTTTyyyyppppeeee))))
  20.  
  21.           SSSSttttaaaattttuuuussss XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyOOOOuuuuttttppppuuuuttttSSSSyyyynnnncccc((((DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,,,,
  22.               iiiinnnntttt ssssccccrrrreeeeeeeennnn,,,,
  23.               iiiinnnntttt cccchhhhaaaannnnnnnneeeellll,,,,
  24.               iiiinnnntttt ssssyyyynnnnccccPPPPoooorrrrttttIIIInnnnddddeeeexxxx,,,,
  25.               iiiinnnntttt ****ssssyyyynnnnccccTTTTyyyyppppeeeeRRRReeeettttuuuurrrrnnnn))))
  26.  
  27.      PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  28.           _d_i_s_p_l_a_y          Specifies the connection to the X server.
  29.  
  30.  
  31.           _s_c_r_e_e_n           Specifies the screen of the X server.
  32.  
  33.  
  34.           _c_h_a_n_n_e_l          Specifies the channel number.
  35.  
  36.  
  37.           _s_y_n_c_P_o_r_t_I_n_d_e_x    Specifies which sync port.  Use one of the
  38.                            following constants for the color
  39.                            components sync outputs:  _X_S_G_I_V_C__S_P_R_e_d,
  40.                            _X_S_G_I_V_C__S_P_G_r_e_e_n, _X_S_G_I_V_C__S_P_B_l_u_e, and
  41.                            _X_S_G_I_V_C__S_P_A_l_p_h_a.  For the auxiliary sync
  42.                            ports, use one of the following constants:
  43.                            _X_S_G_I_V_C__S_P_A_u_x_0, _X_S_G_I_V_C__S_P_A_u_x_1, and
  44.                            _X_S_G_I_V_C__S_P_A_u_x_2.  Alternatively, for the
  45.                            auxiliary sync ports, you may use one of
  46.                            the constants defined in an include file
  47.                            that may be supplied that is specific to
  48.                            your hardware.  Not all sync ports have
  49.                            uniform characteristics; use the function
  50.                            XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyCCCChhhhaaaannnnnnnneeeellllIIIInnnnffffoooo to determine
  51.                            characteristics for each sync port.
  52.  
  53.  
  54.           _s_y_n_c_T_y_p_e         The sync type to enable on this port.
  55.                            Specify one of the values in the set
  56.                            _X_S_G_I_V_C__S_F...
  57.  
  58.  
  59.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  60.  
  61.  
  62.  
  63.      PPPPaaaaggggeeee 1111                                          ((((pppprrrriiiinnnntttteeeedddd 11110000////3333////00002222))))
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttOOOOuuuuttttppppuuuuttttSSSSyyyynnnncccc((((3333))))                     XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttOOOOuuuuttttppppuuuuttttSSSSyyyynnnncccc((((3333))))
  71.  
  72.  
  73.  
  74.         TTTTeeeerrrrmmmmiiiinnnnoooollllooooggggyyyy
  75.           The synchronization signal (or _s_y_n_c signal) is a series of
  76.           pulses that communicate raster geometry to a display device.
  77.           The horizontal sync (or _H-_s_y_n_c) pulse typically indicates
  78.           the termination of one scan line and the start of another,
  79.           visually lower, line.  The vertical sync (or _V-_s_y_n_c) pulse
  80.           typically indicates the display device should reset its
  81.           downward drawing of lines and start the next horizontal line
  82.           at the top of the screen.  When horizontal and vertical sync
  83.           are combined in the same signal, the result is called
  84.           composite sync (sometimes referred to as _H + _V-_s_y_n_c).
  85.  
  86.           A synchronization pulse is a variation from one level to
  87.           another.  The output voltage can be generated at different
  88.           voltages:  nominal video level or TTL levels.  In some video
  89.           formats (e.g., some HDTV formats) a third level of excursion
  90.           is required during some sync pulse sequences; this third
  91.           level is employed in _t_r_i-_l_e_v_e_l _s_y_n_c.
  92.  
  93.  
  94.         SSSSeeeerrrrvvvveeeerrrr CCCCoooonnnnffffiiiigggguuuurrrraaaattttiiiioooonnnnssss
  95.           These functions deal with the synchronization signal's
  96.           presence on one of the channel's sync output ports.
  97.           Different servers may have different hardware available for
  98.           sync output:  some ports may be separate connectors
  99.           (auxiliary sync outputs) on which sync is delivered; the
  100.           red, green, and blue color component signals may contain
  101.           sync; some servers provide an alpha channel output
  102.           connector, and sync may also be available on that port.
  103.           Sync output may be unique to a channel - and servers may not
  104.           provide sync outputs uniformly, so each channel's ports must
  105.           be considered separately.
  106.  
  107.           Sync is available in different forms, depending on server
  108.           hardware.  Servers may permit a specific port to generate
  109.           none, one or both of horizontal and vertical sync;
  110.           capabilities of the ports may not be uniform among channels,
  111.           or even among ports for a single channel.
  112.  
  113.           Especially for sync on the color components, a server may
  114.           support independent adjustment of each component's sync, or
  115.           may support only a global change such that sync is enabled
  116.           or disabled for all color components simultaneously.  Refer
  117.           to hardware documentation for information on server support.
  118.           Applications written for use on more than one type of
  119.           hardware should query all color component values after
  120.           setting one to determine whether the sync change was
  121.           independently adjusted.
  122.  
  123.           The entire set of all sync ports and sync types available
  124.           for that port may be determined from the structure returned
  125.           from the function XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyCCCChhhhaaaannnnnnnneeeellllIIIInnnnffffoooo.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttOOOOuuuuttttppppuuuuttttSSSSyyyynnnncccc((((3333))))                     XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttOOOOuuuuttttppppuuuuttttSSSSyyyynnnncccc((((3333))))
  137.  
  138.  
  139.  
  140.         FFFFuuuunnnnccccttttiiiioooonnnnssss
  141.           XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttOOOOuuuuttttppppuuuuttttSSSSyyyynnnncccc(((()))) enables and disables sync on one of
  142.           the sync output ports.
  143.  
  144.           XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyOOOOuuuuttttppppuuuuttttSSSSyyyynnnncccc(((()))) returns the current settings for
  145.           sync on one of the output ports.
  146.  
  147.  
  148.         IIIInnnntttteeeerrrraaaaccccttttiiiioooonnnn WWWWiiiitttthhhh SSSSccccrrrreeeeeeeennnn SSSSaaaavvvveeeerrrr PPPPrrrrooooggggrrrraaaammmmssss
  149.           Some screen savers may use these functions to alter sync
  150.           output to trigger power-saving measures on monitors which
  151.           have the capability to run with reduced power during periods
  152.           of inactivity.  Alteration of output sync may interfere with
  153.           normal operation of these screen savers and monitors.
  154.  
  155.  
  156.      EEEEVVVVEEEENNNNTTTTSSSS
  157.           When this control is altered, the server generates a
  158.           OutputSyncNotify event.
  159.  
  160.  
  161.      RRRREEEETTTTUUUURRRRNNNNEEEEDDDD VVVVAAAALLLLUUUUEEEE
  162.           XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyOOOOuuuuttttppppuuuuttttSSSSyyyynnnncccc returns TRUE if successful, FALSE upon
  163.           failure.  Specification of non-existent port number returns
  164.           FALSE.
  165.  
  166.           Other errors are reported via standard X protocol error
  167.           mechanism.  Parameter errors are reported via BadValue or
  168.           BadMatch.
  169.  
  170.  
  171.  
  172.  
  173.      SSSSTTTTRRRRUUUUCCCCTTTTUUUURRRREEEESSSS
  174.           /* Special sync port IDs */
  175.           #define XSGIVC_SPRed               -1
  176.           #define XSGIVC_SPGreen             -2
  177.           #define XSGIVC_SPBlue              -3
  178.           #define XSGIVC_SPAlpha             -4
  179.           #define XSGIVC_SPAux0              0
  180.           #define XSGIVC_SPAux1              1
  181.           #define XSGIVC_SPAux2              2
  182.  
  183.           /* See syncType in XSGIvcSyncInfo */
  184.           #define XSGIVC_SFNone              0   /* No sync */
  185.           #define XSGIVC_SFHorizontalVideo   1   /* Horizontal sync, video level */
  186.           #define XSGIVC_SFVerticalVideo          2   /* Vertical sync, video level */
  187.           #define XSGIVC_SFCompositeVideo         3   /* Composite sync, video level */
  188.           #define XSGIVC_SFHorizontalTTL     4   /* Horizontal sync, TTL level */
  189.           #define XSGIVC_SFVerticalTTL            5   /* Vertical sync, TTL level */
  190.           #define XSGIVC_SFCompositeTTL           6   /* Composite sync, TTL level */
  191.           #define XSGIVC_SFHorizontalTriLevel     7   /* Horizontal sync, tri-level */
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttOOOOuuuuttttppppuuuuttttSSSSyyyynnnncccc((((3333))))                     XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttOOOOuuuuttttppppuuuuttttSSSSyyyynnnncccc((((3333))))
  203.  
  204.  
  205.  
  206.           #define XSGIVC_SFVerticalTriLevel  8   /* Vertical sync, tri-level */
  207.           #define XSGIVC_SFCompositeTriLevel 9   /* Composite sync, tri-level */
  208.  
  209.  
  210.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  211.           XSGIvc, XSGIvcQueryChannelInfo
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 10/3/02)
  262.  
  263.  
  264.  
  265.